Crate configure_me_codegen
source ·Expand description
This is the codegen part of configure_me
crate. Please refer to the documentation of
configure_me
for details.
Beautiful error messages
This crate supports emitting beautiful, Rust-like, error messages from build script.
This improves developer experience a lot at the cost of longer compile times.
Thus it is recommended to turn on the feature during development
and keep it off during final release production build.
To emit beautiful messages activate the spanned
feature.
Unstable metabuild feature
This crate supports nightly-only metabuild
feature tracked in https://github.com/rust-lang/rust/issues/49803
Since it is unstable you have to opt-in to instability by activating unstable-metabuild
Cargo
feature. If you enable it you don’t have to write build script anymore, just add
metabuild = ["configure_me_codegen"]
to [package]
section of your Cargo.toml
. Note that
you still have to specify the dependency (with the feature) in [build-dependencies]
.
No guarantees about stability are made because of the nature of nightly. Please use this only
to test metabuild
feature of Cargo and report your experience to the tracking issue. I look
forward into having this stable and the main way of using this crate. Your reports will help.
Modules
Structs
- Error that occured during code generation
Functions
- build_scriptDeprecatedGenerates the source code for you from provided
toml
configuration file. - Generates the source code for you
- build_script_with_manDeprecatedGenerates the source code and manual page at default location.
- build_script_with_man_written_toDeprecatedGenerates the source code and manual page at specified location.
- Generates man page only.
- Generates the source code for you from provided
toml
configuration.